package nl.jteam.jsa.core;

/**
 * Represents an entry of a facet. An entry holds a unique value of a facet along with some addition info on that value.
 * Currently this additional info solely consists of the value count (the number of documents in the corpus to adhere
 * to the facet value).
 *
 * @author Uri Boness
 */
public interface FacetEntry {

    /**
     * Returns the value of the facet.
     *
     * @return The value of the facet.
     */
    Object getValue();

    /**
     * Returns the number of documents in the search engine corpus to adhere to the facet value.
     *
     * @return The number of documents in the search engine corpus to adhere to the facet value.
     */
    int getCount();

}
